BackgroundServiceDomain

class BackgroundServiceDomain : Domain

Defines events for background web platform features.

This API is marked as experimental in protocol definition and can change in the future.

Functions

backgroundServiceEventReceived
Link copied to clipboard
fun backgroundServiceEventReceived(): Flowable<BackgroundServiceEventReceivedEvent>
Called with all existing backgroundServiceEvents when enabled, and all new events afterwards if enabled and recording.
clearEvents
Link copied to clipboard
fun clearEvents(input: ClearEventsRequest): Single<RequestResponseFrame>
Clears all stored data for the service.
description
Link copied to clipboard
fun description(): String
Returns domain description.
events
Link copied to clipboard
fun events(): Flowable<Event>
Returns flowable capturing all domains events.
fun events(filter: Predicate<Event>): Flowable<Event>
Returns flowable capturing all domains events matching predicate.
fun <T : Event> events(eventClass: Class<T>): Flowable<T>
Returns flowable capturing all domain events of a given type.
fun <T : Event> events(eventClass: Class<T>, filter: Predicate<T>): Flowable<T>
Returns flowable capturing all domain events of a given type matching predicate.
getDependencies
Link copied to clipboard
open fun getDependencies(): List<Domain>
Returns domain dependencies.
name
Link copied to clipboard
fun name(): String
Returns domain name.
recordingStateChanged
Link copied to clipboard
fun recordingStateChanged(): Flowable<RecordingStateChangedEvent>
Called when the recording state for the service has been updated.
setRecording
Link copied to clipboard
fun setRecording(input: SetRecordingRequest): Single<RequestResponseFrame>
Set the recording state for the service.
startObserving
Link copied to clipboard
fun startObserving(input: StartObservingRequest): Single<RequestResponseFrame>
Enables event updates for the service.
stopObserving
Link copied to clipboard
fun stopObserving(input: StopObservingRequest): Single<RequestResponseFrame>
Disables event updates for the service.

Sources

jvm source
Link copied to clipboard